/projects/{projectId}/historianConnections (Get)

Get	/projects/{projectId}/historianConnections

In This Topic

Description

returns a list of historianConnections in a project that satisfy the filter criteria

Parameters

Name	Description	Data Type
projectId	the id of the project to look in	string
skip	number of records to skip for pagination	integer (int32)
limit	maximum number of records to return	integer (int32)
connectionID	provides a wild card string to filter connections by their connectionID.	string
serverName	a wild card string to filter the connection list by server name.	string
description	a wild card string to filter the connection list by description.	string

200 Response

The collection of historian connections that satisfy the query.

HistorianConnectionsGetResponse

The results of the historian connections get query.

HistorianConnections : Array[CimHistorianConnection]

An array of the historian connections that satify the query criteria.

ConnectonID : string

The Id of historian connection.

ServerName : string

The server that the connection will connect to.

Description : string

The desciption of the connection.

UserID : string

The user ID the connection is made with.

Passsword : string

The password the connection is made with. This password will not be in get responses. It may be in create/update requests.

UsesIdentity : boolean

set it to true to specify user name and password.

Fault Responses

Fault	Description
404	This fault returns a response body of type ProblemDetails. project with the given id is not registered on the system

Remarks

By passing a registered project id you can get a list of classes in this project